CAMEL-23576: docs - sync camel-jira upgrade-guide entry to main (4_18 / 4_14) and flag as potential breaking change#23475
Merged
Conversation
…4_14 and flag as potential breaking change Per the backport upgrade-guide policy, the camel-4x-upgrade-guide-4_XX.adoc files for all versions live on main as the canonical history. The 4.18.x and 4.14.x backports of apache#23417 (PRs apache#23460 / apache#23472) add a camel-jira entry to the 4.18 and 4.14 upgrade guides on their maintenance branches; this mirrors those entries onto main. Also flags the existing 4.21 camel-jira entry as a "potential breaking change" in its heading, consistent with the other header-rename entries (camel-grok, camel-jgroups) and to make the literal-string-value migration risk explicit. Reported by Claude Code on behalf of Andrea Cosentino Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
gnodet
approved these changes
May 22, 2026
Contributor
gnodet
left a comment
gnodet
left a comment
There was a problem hiding this comment.
LGTM. Clean doc-sync that follows the backport upgrade-guide policy correctly.
Verified:
- The entries are placed under the correct version sections: "Upgrading from 4.14.3 to 4.14.8" and "Upgrading from 4.18.1 to 4.18.3", matching the target versions of the backport PRs (#23460, #23472).
- The content (table + DSL accessor bullet list) is identical to the existing 4.21 entry on
main, which is the expected behavior for a doc-sync. - The header constant previous/new values in the table match the actual code merged in #23417.
- The
ISSUE_COMMENTconstant is correctly listed in the table but omitted from the Endpoint DSL accessor list (it has no@Metadataannotation, so noJiraHeaderNameBuilderaccessor is generated). This is consistent with the existing 4.21 entry. - The "potential breaking change" suffix on the heading is consistent with other header-rename entries in the same guides (
camel-grok,camel-jgroups,camel-cxf). - AsciiDoc formatting is correct: proper table syntax with
[options="header"], consistent use of backtick-quoted constants, and bullet-list formatting for the DSL accessors.
One minor note (non-blocking): the backport PRs #23460 (4.18.x) and #23472 (4.14.x) are still open. This doc-sync PR can be merged before or after them since it only touches main, but the version sections on main ("4.14.8", "4.18.3") assume those backports will land.
Claude Code on behalf of Guillaume Nodet
Contributor
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
Contributor
|
🧪 CI tested the following changed modules:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only follow-up to #23417 (merged) and its backports #23460 (4.18.x) / #23472 (4.14.x).
What
Per the project backport upgrade-guide policy, the
camel-4x-upgrade-guide-4_XX.adocfiles for all versions live onmainas the canonical history across releases. This PR:camel-jiraheader-rename entry tocamel-4x-upgrade-guide-4_18.adocon main (mirrors the 4.18.x backport CAMEL-23576: camel-jira - align Exchange header constant names with Camel naming convention #23460, target 4.18.3).camel-4x-upgrade-guide-4_14.adocon main (mirrors the 4.14.x backport CAMEL-23576: camel-jira - align Exchange header constant names with Camel naming convention #23472, target 4.14.8).camel-jiraentry as a potential breaking change in its heading, consistent with the other header-rename entries (camel-grok,camel-jgroups) and to make the literal-string-value migration risk explicit.Why
Without this sync,
main's version-specific 4.18/4.14 guides would drift out of sync with what actually ships on the maintenance branches.No code changes; docs only.
Reported by Claude Code on behalf of Andrea Cosentino